home *** CD-ROM | disk | FTP | other *** search
/ The Original Shareware 1.1 / The Original Shareware (WeMake CDs)(Volume 1.1)(CDs, Inc)(1993).iso / 7 / zip123.zip / ZIP.DOC < prev   
Text File  |  1989-01-21  |  14KB  |  276 lines
  1.  
  2.                                    ZIP.DOC
  3.                                    -------
  4.                            Instructions for ZIP.COM
  5.                    IBM PC Fast Serial File Transfer Utility
  6.                             Version 1.23 (1/21/89)
  7.  
  8.                                (c)1989 E. Meyer
  9.  
  10.     Requires:  two 100% IBM PC compatible computers;  MS/PCDOS 2.x or 3.x
  11.  
  12.  
  13.  
  14.      ZIP is a tiny, fast utility to transfer files between two IBM compatible 
  15. computers over an ordinary serial cable connection.  This can be more 
  16. convenient than constantly swapping disks; of course, it is necessary when the 
  17. computers don't share a common disk format, as in the case of a desktop PC 
  18. with 5" drives and a laptop (or PS/2) with only a 3" drive.  ZIP is easier to 
  19. use, and (potentially) over 6 times faster for this purpose, than any ordinary 
  20. telcom program.
  21.  
  22.               Telcom programs: modem       2400 bps      0.3 K/sec
  23.               Telcom programs: cable      19200 bps      2.3 K/sec
  24.         --->  ZIP: cable                 115200 bps     14.1 K/sec
  25.  
  26.      Most computer manufacturers offer additional disk drives or other 
  27. hardware accessories to provide access to data on both 3" and 5" disks; but 
  28. these can cost hundreds of dollars, and make a laptop computer far less 
  29. portable.  There are also several commercial programs for serial transfer; 
  30. I'm sure they work very well, and have many extra conveniences that ZIP lacks.  
  31. But even they are priced at $100 and up, which is far more than I was willing 
  32. to pay.  ZIP transfers files just as well, and is free.  (ZIP does NOT [yet] 
  33. transfer subdirectories, only files.)
  34.  
  35.  
  36.                                   BASIC USE
  37.  
  38.      Obviously, you will need to get copies of (compatible versions of) 
  39. ZIP.COM onto both computers.  (You can accomplish this at 19200 bps using your 
  40. serial cable, if both machines have telcom software with XMODEM protocol 
  41. transfers.)
  42.  
  43.      ZIP makes transferring a file as easy as copying it from one disk to 
  44. another.  To transfer any MSDOS file, once the cable is properly connected to 
  45. the serial (COM) ports of the two computers, from any DOS prompt:
  46.  
  47.            1.  Menu-driven operation.  Simply type "ZIP" on both 
  48.       machines; the program will step you through all the necessary 
  49.       choices, including sending or receiving files.
  50.  
  51.            2.  Command line operation, for experienced users.
  52.       On the sending machine, type:       On the receiving machine:
  53.              C>zip FILENAME                      C>zip /r
  54.                                              or  C>zip DIRECTORY /r
  55.  
  56.                The "FILENAME" you give can be a single file, or a 
  57.       GROUP specified by wildcards and/or commas (see examples below).  
  58.       Each name may include a directory.  Each file will appear with 
  59.       the same name on the receiving end.  As data is transferred you 
  60.       should see a blinking asterisk.  When you see the message 
  61.       "Verified", you know that the received copy exactly matches the 
  62.       original.
  63.                The "/R" option means RECEIVE.  The "DIRECTORY" to 
  64.       receive files may optionally be specified; otherwise, the 
  65.       current directory is used.  Large transfer jobs will go faster 
  66.       if you use a hard or RAM disk, which work faster than a floppy 
  67.       drive, where possible.
  68.  
  69. ZIP can be aborted by pressing any key:
  70.               (1) on either end, during initial handshaking
  71.               (2) on sending end, during file transfer
  72.                     (will abort once current file is finished)
  73. as well as by pressing ^C at any menu prompt.
  74.  
  75.  
  76.                           SELECTING THE SERIAL PORT
  77.  
  78.      By default ZIP uses the COM1 port.  IBM-compatible computers have 
  79. anywhere from one to four serial (RS232) ports.  The first two, COM1 and COM2, 
  80. are implemented at standard addresses (03F8, 02F8); COM3 and COM4, if present, 
  81. can vary from one computer to another.  To use them, or to change the default 
  82. to COM2, you will have to install the appropriate address in ZIP.COM (see 
  83. below).
  84.  
  85.      You can select either COM1 or COM2 during operation of ZIP:  in menu 
  86. mode, just select the option to "M"odify parameters.  In command line mode, 
  87. specify one of the following options:
  88.               /1   = Use the COM1 port.  (This is normally the default.)
  89.               /2   = Use the COM2 port.
  90.  
  91.      You will see a note in the ZIP signon message, "Port=____", giving the 
  92. port address in use.
  93.  
  94.  
  95.                              SELECTING THE SPEED
  96.  
  97.      By default ZIP works at 115200 bps.  You can request a "moderate" or 
  98. "slow" speed instead (one-half or one-third of the "fast" rate).  If you like, 
  99. you can make one of the slower speeds your default, by installing it in 
  100. ZIP.COM (see below).
  101.      NOTE: due to the limited speed of the CPU itself, most computers can't 
  102. actually achieve the 115200 bps throughput that the serial port is capable of.  
  103. You will probably find little difference in operation between the three 
  104. "speeds", unless you have a very fast 80286 or 80386-based machine.  This 
  105. means that transferring files from such a computer to an ordinary PC may not 
  106. work at the "fast" rate because the receiver simply can't keep up!  Under such 
  107. circumstances you will need to specify a slower speed.
  108.  
  109.      To select a speed other than the default: in menu mode, just select the 
  110. option to "M"odify parameters.  In command line mode, specify one of the 
  111. following options:
  112.               /F   = Use the fast speed (115200 bps).
  113.               /M   = Use the moderate speed (57600 bps).
  114.               /S   = Use the slow speed (38400 bps).
  115.  
  116.      Naturally these must be specified on BOTH ends, if used.  You will see a 
  117. note in the ZIP signon message, "Speed=____", giving the speed in use.
  118.  
  119.  
  120.                       USAGE EXAMPLES (Command line mode)
  121.  
  122.      C>zip \work\my         sends file C:\WORK\MY
  123.  
  124.      C>zip gort,klaatu /s   sends C:GORT, C:KLAATU at slow speed
  125.  
  126.      C>zip my.* /2          sends all files C:MY.* over COM2
  127.  
  128.      C>zip /r               receives files into current directory
  129.  
  130.      C>zip \work /rs        receives into directory C:\WORK\ at slow speed
  131.  
  132.      C>zip d: /r2           receives files over COM2 into directory D:
  133.  
  134.  
  135.  
  136.                               TECHNICAL DETAILS
  137.  
  138.      ZIP does full CRC (Cyclic Redundancy Checksum) verification on the 
  139. received file.  Being designed for direct serial transfer at maximum hardware 
  140. speed, ZIP is not compatible with other software, including ordinary telcom 
  141. programs.  Do not disturb the cable when ZIP is running, as this may cause the 
  142. program to stall, requiring a reboot of your computer(s).
  143.  
  144.      Be sure to use the SAME version of ZIP on both ends: the transfer 
  145. protocol may have changed.  Otherwise, if you can't get ZIP to transfer files, 
  146. your computer(s) or your cable are incompatible.  ZIP is written entirely in 
  147. assembly language; it will only work on fully IBM compatible computers.  I 
  148. have developed it on 8088 PC clones with clock speeds of 4.77 to 8 MHz; I rely 
  149. on users' reports that it works well on more sophisticated systems.
  150.  
  151.      SERIAL CABLES can be wired in many different ways.  The one I use was 
  152. labeled as an "IBM AT adapter", and had female connectors on both ends (one 
  153. DB9, one DB25).  Any cable that doesn't work by itself should with a null 
  154. modem adapter.  Basically, you need to have the transmit and receive data 
  155. lines (pins 2 and 3 on a DB25) crossed, and ground (7) straight through.  If 
  156. you have to build your own cable, you'll discover whether any more connections 
  157. are needed.  Don't ask me for further advice: I don't know any more about this 
  158. than you do!  People get rich writing books on the intricacies of the RS232 
  159. "standard"; you may want to look for one.
  160.  
  161.  
  162.                             MODIFYING THE DEFAULTS
  163.  
  164.      If you don't instruct it otherwise, ZIP will use its built-in "defaults" 
  165. for the serial port address and speed.  These values appear in simple ASCII 
  166. text form at the start of ZIP.COM, and can be modified to customize your copy 
  167. of ZIP.  To get a quick look at the current settings, just enter:
  168.  
  169.                       C>type zip.com
  170.                       [ZIP 1.23 Port=03F8 Speed=F]
  171.  
  172.      For the Port, you can use "03F8" (COM1), "02F8" (COM2), or whatever (see 
  173. your computer manual for COM3 or COM4 port addresses).  The possible values 
  174. for Speed are "F", "M", or "S".  Changes can be made with any patching 
  175. utility, such as DEBUG.  Just change the data under "Defaults:" to whatever 
  176. you require.  After modifying the defaults, you can still use any command-line 
  177. options above to override them.
  178.      Here is how the DEBUG session might look; we Display the default data, 
  179. Enter 0"2"F8 in place of the 03F8 to change to a default of COM2, Display 
  180. again to see the new value, Write the change to the file, and then Quit:
  181.  
  182. C:\WORK>debug zip.com
  183. -d100,11f
  184. 22FA:0100  EB 20 0D 5B 5A 49 50 20-31 2E 32 33 20 50 6F 72   . .[ZIP 1.23 Por
  185. 22FA:0110  74 3D 30 33 46 38 20 53-70 65 65 64 3D 46 5D 0D   t=03F8 Speed=F].
  186. -e113 32            ^^                                          ^
  187. -d100,11f
  188. 22FA:0100  EB 20 0D 5B 5A 49 50 20-31 2E 32 33 20 50 6F 72   . .[ZIP 1.23 Por
  189. 22FA:0110  74 3D 30 32 46 38 20 53-70 65 65 64 3D 46 5D 0D   t=02F8 Speed=F].
  190. -w                  ^^                                          ^
  191. Writing xxxx bytes
  192. -q
  193.  
  194.      For further information on DEBUG see your MSDOS manual.  Please DO NOT 
  195. distribute modified copies of ZIP.COM; this could confuse other users.  They 
  196. are for your personal use only.
  197.  
  198.  
  199.                               PROBLEMS USING ZIP
  200.  
  201.      ZIP seems to work on nearly all systems very well now.  Certain 
  202. (combinations of?) computers, however, may regularly experience COMM FAILURE 
  203. errors.  If you have this problem, please report the numerical code (1-6) now 
  204. included with this error message -- it may help me figure out a way to solve 
  205. the problem.  (Note: for COMM FAILURE in transfers from a very fast computer 
  206. to a slow one, see SELECTING THE SPEED, above.)
  207.  
  208.  
  209.                                 ERROR MESSAGES
  210.  
  211.             <ERROR>  invalid command (probably illegal option).
  212.     <OUT OF MEMORY>  less than 64K free RAM available.
  213.          <TOO MANY>  global filespec includes too many files.
  214.        <READ ERROR>  trouble reading source file.
  215.       <WRITE ERROR>  trouble writing destination file.  (Disk full?)
  216.    <COMM FAILURE #>  unexpected transmission error.
  217.         <CRC ERROR>  received file CRC did not match, bad transfer.
  218.           <ABORTED>  you pressed a key.
  219.  
  220.  
  221.                           ZIP 1.22 TRANSFER PROTOCOL
  222.  
  223.      This information is provided for programmers interested in writing 
  224. applications compatible with ZIP on other computer systems.  (If you do this, 
  225. please let me know.  MAC-ZIP, anyone?  CPM-ZIP?)  The current protocol is 
  226. version 1.22.  The protocol may need to be modified again with future 
  227. development of ZIP.  All transfer takes place at 115200 bps (unless a slower 
  228. speed is selected); very tight polling loops, minimal handshaking, and fixed 
  229. packet size are needed to avoid loss of data at 115200 bps.
  230.  
  231.      The initial handshaking involves the receiver sending a version code byte 
  232. (122 decimal, for ZIP 1.22 protocol) at intervals until it is acknowledged 
  233. (ACK, 6 decimal) by the sender.  From this point on all data transfer is in 
  234. fixed-size packets.
  235.      The receiver, when ready, requests each packet by sending an ENQ (5 
  236. decimal).  Each packet has a 3-byte header, consisting of an SOH (1 decimal) 
  237. and a 16-bit count to indicate the number of significant bytes in the packet; 
  238. then exactly 512 bytes of data; then a concluding ETX (3 decimal).
  239.      The first packet contains the file name; an empty name packet (0 bytes 
  240. length) signifies the end of the transmission.  Subsequent packets contain the 
  241. file data; a packet that is less than full (count less than 512) signifies the 
  242. end of the file.  One final packet contains the 16-bit CCITT CRC value for the 
  243. entire file, the DOS time stamp word, and the DOS date stamp word, in that 
  244. order (6 bytes).
  245.      The receiver looks for the SOH and ETX bounding each packet, but does no 
  246. further checking.  There are no timeouts.  No attempt is made to resend 
  247. packets; under normal circumstances, transmission errors should not occur.  
  248. Upon any serious error, a NAK (21 decimal) is sent to the other end before 
  249. exiting to DOS.  Upon receipt of this signal, the other end also terminates.
  250.  
  251.  
  252.                                    HISTORY
  253.  
  254. ZIP 1.0  (4/88) - trial release.  Worked on many systems.
  255.     1.1  (4/88) - improved transmission algorithm; batch transfers allowed 
  256.                  using wildcards and/or commas; receive directory option; 
  257.                  original file time/date preserved.
  258.     1.2  (5/88) - improved error handling; patchable default port also 
  259.                  allows use of COM3,4; small bug fixes.
  260.    1.21  (5/88) - slower speed options; fixed bug in initializing ports.
  261.    1.22  (8/88) - protocol modified for better results on computers of
  262.                  widely different speeds; fixed bug in deleting temp file.
  263.    1.23  (1/89) - menu-driven operation; detects disk-full errors.
  264.  
  265.  
  266.      ZIP and its documentation are (c)1989 E. Meyer, all rights reserved.  
  267. They may be freely distributed, but not modified or sold for profit without 
  268. my written consent.  The user takes full responsibility for any damages 
  269. resulting from the use (or misuse) of this program.  Please report any 
  270. problems encountered.
  271.  
  272.                  Eric Meyer
  273.             401 12th Ave SE, #139            CompuServe [74415,1305]
  274.               Norman, OK  73071
  275.  
  276.